Dubbo stub (Dubbo 本地存根)

发表于 | 分类于

Dubbo 本地存根的实现

  • 根据 Dubbo 官网的介绍

    • 远程服务后，客户端通常只剩下接口，而实现全在服务器端，但提供方有些时候想在客户端也执行部分逻辑，比如：做 ThreadLocal 缓存，提前验证参数，调用失败后伪造容错数据等等，此时就需要在 API 中带上 Stub，客户端生成 Proxy 实例，会把 Proxy 通过构造函数传给 Stub，然后把 Stub 暴露给用户，Stub 可以决定要不要去调 Proxy.
      image

    • Stub 使用

      • 在 spring 配置文件中按以下方式配置：

        <dubbo:reference interface=”com.foo.BarService” stub=”true” />

      或

      <dubbo:reference interface=”com.foo.BarService” stub=”com.foo.BarServiceStub” />

      • 提供 Stub 实现
        1
        2
        3
        4
        5
        6
        7
        8
        9
        10
        11
        12
        13
        14
        15
        16
        17
        18
        19
        package com.foo;
        public class BarServiceStub implements BarService { 
            private final BarService barService;

            // 必须提供可传入 proxy 的构造方法
            public BarServiceStub(BarService barService) {
                this.barService = barService;
            }

            public String sayHello(String name) {
                // 此代码在客户端执行, 你可以在客户端做ThreadLocal本地缓存，或  预先验证参数是否合法，等等
                try {
                    return barService.sayHello(name);
                } catch (Exception e) {
                    // 你可以容错，可以做任何AOP拦截事项
                    return "容错数据";
                }
            }
        }

  • 具体实现

    • 具体实现其实很简单，通过在服务引用的过程中生成代理类的时候嵌入 Stub 的实现
    • 通过 org.apache.dubbo.rpc.proxy.wrapper.StubProxyFactoryWrapper 代理包装类(SPI 的包装类实现了注入自适应扩展类的功能，通过类似装饰器模式切入 SPI 接口包装实现类的逻辑)来实现，调用 SPI 接口 ProxyFactory.getProxy(Invoker invoker) 的时候会首先执行 org.apache.dubbo.rpc.proxy.wrapper.StubProxyFactoryWrapper#getProxy(org.apache.dubbo.rpc.Invoker) 方法通过反射的方式将生成的代理类注入到 Stub 的实现中，从而达到在 consumer 端执行部分逻辑的目的.